home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / newsgroups / misc.20020314-20021006 / 000416_fdc@columbia.edu_Tue Oct 1 15:32:50 EDT 2002.msg < prev    next >
Text File  |  2020-01-01  |  2KB  |  88 lines
  1. Article: 13752 of comp.protocols.kermit.misc
  2. Path: newsmaster.cc.columbia.edu!news.columbia.edu!news-not-for-mail
  3. From: fdc@columbia.edu (Frank da Cruz)
  4. Newsgroups: comp.protocols.kermit.misc
  5. Subject: Re: Return Value from User Defined Function
  6. Date: 1 Oct 2002 15:31:19 -0400
  7. Organization: Columbia University
  8. Lines: 71
  9. Message-ID: <anct67$ns6$1@watsol.cc.columbia.edu>
  10. References: <ancqme$2980$1@msunews.cl.msu.edu>
  11. NNTP-Posting-Host: watsol.cc.columbia.edu
  12. X-Trace: newsmaster.cc.columbia.edu 1033500680 1005 128.59.39.139 (1 Oct 2002 19:31:20 GMT)
  13. X-Complaints-To: postmaster@columbia.edu
  14. NNTP-Posting-Date: 1 Oct 2002 19:31:20 GMT
  15. Xref: newsmaster.cc.columbia.edu comp.protocols.kermit.misc:13752
  16.  
  17. In article <ancqme$2980$1@msunews.cl.msu.edu>,
  18. Robert Gibbens <rgibbens@redskytech.com> wrote:
  19. : How would I go about evaluating the return value from a User defined
  20. : function?
  21. : For example, I have the function
  22. : 
  23. : DEFINE mlChangePassword {
  24. :     (Do something)
  25. :     IF FAILURE {
  26. :         return 1
  27. :     }
  28. :     else
  29. :     {
  30. :         return 0
  31. :     }
  32. : }
  33. : 
  34. If all you want to do is return success or failure, you would use END rather
  35. than RETURN:
  36.  
  37.   DEFINE mlChangePassword {
  38.       (Do something)
  39.       IF FAILURE {
  40.           end 1
  41.       } else {
  42.           end 0
  43.       }
  44.   }
  45.  
  46. Then you can test the macro invocation with IF SUCCESS / FAILURE:
  47.  
  48.   mlChangePassword someargs...
  49.   if fail exit 1 "Password change failed"
  50.  
  51. If you want a macro to return an arbitrary value, rather than just succeed
  52. or fail, use the RETURN statement.  The return value can be a number, a
  53. string, whatever.  The caller can access the RETURN value in the \v(return)
  54. variable.
  55.  
  56. You can also access a macro's return value directly if you invoke it as
  57. a user-defined function:
  58.  
  59.   .somevariable := \fexecute(macroname args)
  60.  
  61. For example:
  62.  
  63.   define addemup {
  64.       local \%i \%s
  65.       .\%s := 0
  66.       for \%i 1 \v(argc)-1 1 {
  67.           increment \%s \&_[\%i]
  68.       }
  69.       return \%s
  70.   }
  71.   .sum = \fexecute(addemup 1 2 3 4)
  72.   echo \m(sum)
  73.  
  74. which prints:
  75.  
  76.   10
  77.  
  78. The script language is documented in "Using C-Kermit":
  79.  
  80.   http://www.columbia.edu/kermit/ck60manual.html
  81.  
  82. as amplified by the update notes for versions 7 and 8:
  83.  
  84.   http://www.columbia.edu/kermit/ckermit70.html
  85.   http://www.columbia.edu/kermit/ckermit80.html
  86.  
  87. - Frank
  88.